Medication
2.0.0 - STU Belgium flag

Medication, published by eHealth Platform. This guide is not an authorized publication; it is the continuous build for version 2.0.0 built by the FHIR (HL7® FHIR® Standard) CI Build. This version is based on the current content of https://github.com/hl7-be/medication and changes regularly. See the Directory of published versions

Logical Model: KMEHR Medication Schema v5.8

Official URL: https://www.ehealth.fgov.be/standards/fhir/medication/StructureDefinition/KMEHRMS Version: 2.0.0
Draft as of 2024-03-30 Computable Name: KMEHRMS

This model represents the Medication Schema KMEHR V5.8. It is shown for demonstrating the field correspondence/equivalence, and not to imply any intended scope or intended behaviour.

Usage:

  • This Logical Model Profile is not used by any profiles in this Implementation Guide

Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots and how the different presentations work.

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. KMEHRMS 0..*BaseKMEHR Medication Schema v5.8
Instances of this logical model are not marked to be the target of a Reference
... KMEHRMessage 1..1ClassKMEHR Message
.... header 1..1ClassKMEHR Message header
..... standard 1..1ClassWhich version of the standard is used
...... cd 1..1CDThe version of the KMEHR standard used
..... date 0..1dateDate
..... time 0..1timeTime
..... sender 0..1ClassSender
...... hcpartyHub 0..1Classthe identifier of the hub
....... itemId 1..1stringthe hub identifier
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... name 0..1stringthe name of the hub
...... hcpartyOrg 0..1Classthe identifier of the org
....... itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... idencryptionApplication 0..1ANYApplication
....... cdencryptionActor 0..1ClassUsage & cardinality
....... name 0..1stringThe name of the org
...... hcpartyindividual 1..1Classthe identifier of the individual
....... idriziv 0..1stringthe RIZIV individual identifier
....... idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... cd 1..1codethe type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1Classto be checked: usage & cardinality
....... firstname 0..1stringthe first name of the individual
....... familyname 0..1stringthe last name of the individual
Example Example: Hendrix
....... address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
........ cd 1..1ClassCoded value
........ nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..*stringFax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1Classthe software identifier
....... itemId 0..1stringthe software identifier
....... cd 1..1codethe type of the hcparty
....... name 0..1stringThe name of the application.
..... recipient 0..1ClassRecipient
...... hcpartyHub 0..1Classthe identifier of the hub
....... itemId 1..1stringthe hub identifier
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... name 0..1stringthe name of the hub
...... hcpartyOrg 0..1Classthe identifier of the org
....... itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... idencryptionApplication 0..1ANYApplication
....... cdencryptionActor 0..1ClassUsage & cardinality
....... name 0..1stringThe name of the org
...... hcpartyindividual 1..1Classthe identifier of the individual
....... idriziv 0..1stringthe RIZIV individual identifier
....... idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... cd 1..1codethe type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1Classto be checked: usage & cardinality
....... firstname 0..1stringthe first name of the individual
....... familyname 0..1stringthe last name of the individual
Example Example: Hendrix
....... address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
........ cd 1..1ClassCoded value
........ nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..*stringFax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1Classthe software identifier
....... itemId 0..1stringthe software identifier
....... cd 1..1codethe type of the hcparty
....... name 0..1stringThe name of the application.
.... folder 1..1ClassThe only data that matters
..... idkmehr 1..1integerID-KMEHR
..... patient 1..1Classthe patient
...... idinss 0..1stringthe Belgian Social Security Number identifier
...... firstname 0..1stringFirst name of the patient. If no first name exists, the element will be empty.
...... familyname 0..1stringFamily name of the patient
...... birthdate 0..1dateBirth date of the patient (uses the basic data types for dates)
...... deathdate 0..1datethis is not used
...... sex 1..1ClassSex of the patient
....... cd 1..1codeCoded value of patient sex
...... address 0..1ClassHome, work, … address(es) of the patient.
....... cd 1..1codeCoded value
....... zip 0..1integerZip-code of the city
....... city 0..1stringThe name of the city
....... street 0..1stringThe name of the street
....... housenumber 0..1stringHousenumber within the street
...... nationality 0..1stringNationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
....... cd 1..1codeCoded value
...... usuallanguage 0..1stringUsual language of the patient using the W3C language codes.
...... telecom 0..1stringFax, phone, … number(s) of the patient.
...... recorddatetime 0..1ANYDate of recording of the patient data.
...... text 0..1stringComment about the patient.
..... MSTransaction 1..1ClassThe metadata for the message
...... idothers 0..*integerLocal ID of the medication line
...... cd 1..1codecode
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... hcpartyHub 0..1Classthe identifier of the hub
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... version 0..1integerversion of the medication scheme
..... MSETransactionTreatmentSuspension 0..*ClassThe treatment suspension line(s)
...... idkmehr 1..1integerthe KMEHR identifier for the medication line
...... idother 0..*stringLocal ID of the medication line
...... cd 0..*codeCoded value
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... hcpartyHub 0..1Classthe identifier of the hub
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... itemmedication 0..*ClassThis describes the medication it is linked to, but has no further relevance
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... beginMoment 1..1ClassThe beginmoment of the medication/treatment suspension
........ date 1..1dateDate
........ time 0..1timeTime
....... endMoment 0..1Classthe end date (and time) of the suspension
........ date 1..1dateDate
........ time 0..1timeTime
....... content 0..*ClassTo Do
........ medicinalproduct 0..*ClassDescription of the medicinal product
......... intendedName 0..1STName of prescribed product
......... intendedCd 0..1CDCD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..*ClassDescription of the generic product
......... intendedName 0..1STName of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1CDCode of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCode of delivered product (CNK)
........ compoundprescription 0..*ClassDescription of the compound product
......... magistraltext 1..1STRecipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
......... compound 0..0
......... formularyReference 0..0
....... text 0..*stringMandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
....... lifecycle 1..1stringThe indication of the status, only used in a TS with value 'suspended'
....... lnk 1..1stringusing a link to the transaction (in the current MedicationSchema) of the related medicine
...... itemtransactionreason 0..1ClassExtra information on the reason of suspention of the linked medication
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contenttext 0..*ClassText
........ text 1..*stringcardinality to be checked

Example Example: Temporairement ne pas prendre en raison de l'interaction avec Y.
..... MSETransactionmedication 0..*ClassThe medication lines
...... idkmehr 1..1integerthe KMEHR identifier for the medication line
...... idother 0..*stringLocal ID of the medication line
...... cd 0..*codeCoded value
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... hcpartyHub 0..1Classthe identifier of the hub
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... version 0..*stringTO DO
...... itemmedicationUse 0..1ClassExtra information on the usage of the medication within this transaction
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itemendCondition 0..1ClassExtra information on the endcondition of the medication within this MSE-transaction
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itembeginCondition 0..1ClassExtra information on the begincondition of the medication within this MSE-transaction
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itemorigin 0..0
...... itemmedicationType 0..0
...... itemadaptationFlag 0..0
...... itemmedication 0..*ClassTo Do
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... beginMoment 1..1ClassThe beginmoment of the medication/treatment suspension
........ date 1..1dateDate
........ time 0..1timeTime
....... endMoment 0..1ClassThe end moment of the medication/treatment suspension
........ date 1..1dateDate
........ time 0..1timeTime
....... duration 0..1integerThe duration of the treatment
....... contentmedicationIdentification 0..*ClassTo Do
........ medicinalproduct 0..*ClassDescription of the medicinal product
......... intendedName 0..1STName of prescribed product
......... intendedCd 0..1CDCD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..*ClassDescription of the generic product
......... intendedName 0..1STName of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1CDCode of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCode of delivered product (CNK)
........ compoundprescription 0..*ClassDescription of the compound product
......... magistraltext 1..1STRecipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
......... compound 0..0
......... formularyReference 0..0
....... content 0..*stringExtra content field which can be added if neccessary
....... text 0..*stringMandatory if compoundprescription is used

Example Example: Aluminiumchloride transpiratieremmende hydroalcoholische oplossing 15 % TMF
....... temporality 0..*ClassThe temporality
........ cd 0..1stringCoded value
....... frequency 0..*ClassTo Do
........ periodicity 0..*ClassTo Do
......... cd 0..*ANYS-VALUE=CD-PERIODICITY
....... posology 0..*ClassThe freetext posology is mutual exclusive with the structured Regimen
........ text 1..1stringContains the ingestion pattern in textual form
Example Example: tot 4 x per dag 1 tablet
........ low 0..0
........ high 0..0
........ unit 0..0
........ takes 0..0
....... regimen 0..*ClassTo Do
........ date 0..*datedate, mostly used icw periodicity=monthly or at a specifiec time of the day
........ weekday 0..*integerDay of the week, mostly used icw periodicity=weekly
......... cd 1..1stringthe day of the week
Example Example: monday
........ daynumber 0..*integerDaynumber, mostly used icw periodicity=weekly or daily
........ daytime 0..*Classindication of the intake moment
......... time 1..1dateThe time when the line was registered in the schema
......... dayperiod 1..*Classmutual exclusive with <time>
.......... cd 0..*stringCoded value
........ quantity 1..1ClassTo Do
......... decimal 0..*integerthe amount, expressed in a number
......... unit 0..*Classthe prescribed administration unit where the decimal applies to
.......... cd 0..*stringTo Do
....... route 0..*ClassThe drug administration route
........ cd 0..*ANYTo Do
....... instructionForOverDosing 0..0
....... instructionForReimbursement 0..0
....... isSubstitutionAllowed 0..0
....... feedback 0..0
....... local 0..0
....... batch 0..0
....... deliveryDate 0..0
....... instructionforpatient 0..1stringUsage instructions for the patient.
Example Example: A diminuer si possible

doco Documentation for this format
NameFlagsCard.TypeDescription & Constraintsdoco
.. KMEHRMS 0..*BaseKMEHR Medication Schema v5.8
Instances of this logical model are not marked to be the target of a Reference
... KMEHRMessage 1..1ClassKMEHR Message
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... header 1..1ClassKMEHR Message header
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... standard 1..1ClassWhich version of the standard is used
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... cd 1..1CDThe version of the KMEHR standard used
..... date 0..1dateDate
..... time 0..1timeTime
..... sender 0..1ClassSender
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1Classthe identifier of the hub
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 1..1stringthe hub identifier
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... name 0..1stringthe name of the hub
...... hcpartyOrg 0..1Classthe identifier of the org
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... idencryptionApplication 0..1ANYApplication
....... cdencryptionActor 0..1ClassUsage & cardinality
....... name 0..1stringThe name of the org
...... hcpartyindividual 1..1Classthe identifier of the individual
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... idriziv 0..1stringthe RIZIV individual identifier
....... idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... cd 1..1codethe type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1Classto be checked: usage & cardinality
....... firstname 0..1stringthe first name of the individual
....... familyname 0..1stringthe last name of the individual
Example Example: Hendrix
....... address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 1..1ClassCoded value
........ nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..*stringFax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1Classthe software identifier
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe software identifier
....... cd 1..1codethe type of the hcparty
....... name 0..1stringThe name of the application.
..... recipient 0..1ClassRecipient
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1Classthe identifier of the hub
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 1..1stringthe hub identifier
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... name 0..1stringthe name of the hub
...... hcpartyOrg 0..1Classthe identifier of the org
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... idencryptionApplication 0..1ANYApplication
....... cdencryptionActor 0..1ClassUsage & cardinality
....... name 0..1stringThe name of the org
...... hcpartyindividual 1..1Classthe identifier of the individual
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... idriziv 0..1stringthe RIZIV individual identifier
....... idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... cd 1..1codethe type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1Classto be checked: usage & cardinality
....... firstname 0..1stringthe first name of the individual
....... familyname 0..1stringthe last name of the individual
Example Example: Hendrix
....... address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 1..1ClassCoded value
........ nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..*stringFax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1Classthe software identifier
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe software identifier
....... cd 1..1codethe type of the hcparty
....... name 0..1stringThe name of the application.
.... folder 1..1ClassThe only data that matters
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... idkmehr 1..1integerID-KMEHR
..... patient 1..1Classthe patient
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idinss 0..1stringthe Belgian Social Security Number identifier
...... firstname 0..1stringFirst name of the patient. If no first name exists, the element will be empty.
...... familyname 0..1stringFamily name of the patient
...... birthdate 0..1dateBirth date of the patient (uses the basic data types for dates)
...... deathdate 0..1datethis is not used
...... sex 1..1ClassSex of the patient
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... cd 1..1codeCoded value of patient sex
...... address 0..1ClassHome, work, … address(es) of the patient.
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... cd 1..1codeCoded value
....... zip 0..1integerZip-code of the city
....... city 0..1stringThe name of the city
....... street 0..1stringThe name of the street
....... housenumber 0..1stringHousenumber within the street
...... nationality 0..1stringNationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
....... cd 1..1codeCoded value
...... usuallanguage 0..1stringUsual language of the patient using the W3C language codes.
...... telecom 0..1stringFax, phone, … number(s) of the patient.
...... recorddatetime 0..1ANYDate of recording of the patient data.
...... text 0..1stringComment about the patient.
..... MSTransaction 1..1ClassThe metadata for the message
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idothers 0..*integerLocal ID of the medication line
...... cd 1..1codecode
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1Classthe identifier of the hub
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... version 0..1integerversion of the medication scheme
..... MSETransactionTreatmentSuspension 0..*ClassThe treatment suspension line(s)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idkmehr 1..1integerthe KMEHR identifier for the medication line
...... idother 0..*stringLocal ID of the medication line
...... cd 0..*codeCoded value
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1Classthe identifier of the hub
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... itemmedication 0..*ClassThis describes the medication it is linked to, but has no further relevance
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... beginMoment 1..1ClassThe beginmoment of the medication/treatment suspension
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... endMoment 0..1Classthe end date (and time) of the suspension
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... content 0..*ClassTo Do
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..*ClassDescription of the medicinal product
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
......... intendedCd 0..1CDCD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..*ClassDescription of the generic product
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1CDCode of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCode of delivered product (CNK)
........ compoundprescription 0..*ClassDescription of the compound product
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... magistraltext 1..1STRecipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... text 0..*stringMandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
....... lifecycle 1..1stringThe indication of the status, only used in a TS with value 'suspended'
....... lnk 1..1stringusing a link to the transaction (in the current MedicationSchema) of the related medicine
...... itemtransactionreason 0..1ClassExtra information on the reason of suspention of the linked medication
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contenttext 0..*ClassText
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: Temporairement ne pas prendre en raison de l'interaction avec Y.
..... MSETransactionmedication 0..*ClassThe medication lines
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idkmehr 1..1integerthe KMEHR identifier for the medication line
...... idother 0..*stringLocal ID of the medication line
...... cd 0..*codeCoded value
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1Classthe identifier of the hub
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... version 0..*stringTO DO
...... itemmedicationUse 0..1ClassExtra information on the usage of the medication within this transaction
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itemendCondition 0..1ClassExtra information on the endcondition of the medication within this MSE-transaction
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itembeginCondition 0..1ClassExtra information on the begincondition of the medication within this MSE-transaction
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itemmedication 0..*ClassTo Do
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... beginMoment 1..1ClassThe beginmoment of the medication/treatment suspension
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... endMoment 0..1ClassThe end moment of the medication/treatment suspension
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... duration 0..1integerThe duration of the treatment
....... contentmedicationIdentification 0..*ClassTo Do
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..*ClassDescription of the medicinal product
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
......... intendedCd 0..1CDCD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..*ClassDescription of the generic product
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1CDCode of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCode of delivered product (CNK)
........ compoundprescription 0..*ClassDescription of the compound product
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... magistraltext 1..1STRecipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... content 0..*stringExtra content field which can be added if neccessary
....... text 0..*stringMandatory if compoundprescription is used

Example Example: Aluminiumchloride transpiratieremmende hydroalcoholische oplossing 15 % TMF
....... temporality 0..*ClassThe temporality
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..1stringCoded value
....... frequency 0..*ClassTo Do
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ periodicity 0..*ClassTo Do
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 0..*ANYS-VALUE=CD-PERIODICITY
....... posology 0..*ClassThe freetext posology is mutual exclusive with the structured Regimen
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..1stringContains the ingestion pattern in textual form
Example Example: tot 4 x per dag 1 tablet
....... regimen 0..*ClassTo Do
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 0..*datedate, mostly used icw periodicity=monthly or at a specifiec time of the day
........ weekday 0..*integerDay of the week, mostly used icw periodicity=weekly
......... cd 1..1stringthe day of the week
Example Example: monday
........ daynumber 0..*integerDaynumber, mostly used icw periodicity=weekly or daily
........ daytime 0..*Classindication of the intake moment
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... time 1..1dateThe time when the line was registered in the schema
......... dayperiod 1..*Classmutual exclusive with <time>
.......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.......... cd 0..*stringCoded value
........ quantity 1..1ClassTo Do
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... decimal 0..*integerthe amount, expressed in a number
......... unit 0..*Classthe prescribed administration unit where the decimal applies to
.......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.......... cd 0..*stringTo Do
....... route 0..*ClassThe drug administration route
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ANYTo Do
....... instructionforpatient 0..1stringUsage instructions for the patient.
Example Example: A diminuer si possible

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()
NameFlagsCard.TypeDescription & Constraintsdoco
.. KMEHRMS 0..*BaseKMEHR Medication Schema v5.8
Instances of this logical model are not marked to be the target of a Reference
... KMEHRMessage 1..1ClassKMEHR Message
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... header 1..1ClassKMEHR Message header
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... standard 1..1ClassWhich version of the standard is used
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... cd 1..1CDThe version of the KMEHR standard used
..... date 0..1dateDate
..... time 0..1timeTime
..... sender 0..1ClassSender
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1Classthe identifier of the hub
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 1..1stringthe hub identifier
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... name 0..1stringthe name of the hub
...... hcpartyOrg 0..1Classthe identifier of the org
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... idencryptionApplication 0..1ANYApplication
....... cdencryptionActor 0..1ClassUsage & cardinality
....... name 0..1stringThe name of the org
...... hcpartyindividual 1..1Classthe identifier of the individual
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... idriziv 0..1stringthe RIZIV individual identifier
....... idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... cd 1..1codethe type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1Classto be checked: usage & cardinality
....... firstname 0..1stringthe first name of the individual
....... familyname 0..1stringthe last name of the individual
Example Example: Hendrix
....... address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 1..1ClassCoded value
........ nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..*stringFax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1Classthe software identifier
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe software identifier
....... cd 1..1codethe type of the hcparty
....... name 0..1stringThe name of the application.
..... recipient 0..1ClassRecipient
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1Classthe identifier of the hub
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 1..1stringthe hub identifier
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... name 0..1stringthe name of the hub
...... hcpartyOrg 0..1Classthe identifier of the org
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... idencryptionApplication 0..1ANYApplication
....... cdencryptionActor 0..1ClassUsage & cardinality
....... name 0..1stringThe name of the org
...... hcpartyindividual 1..1Classthe identifier of the individual
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... idriziv 0..1stringthe RIZIV individual identifier
....... idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... cd 1..1codethe type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1Classto be checked: usage & cardinality
....... firstname 0..1stringthe first name of the individual
....... familyname 0..1stringthe last name of the individual
Example Example: Hendrix
....... address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 1..1ClassCoded value
........ nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..*stringFax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1Classthe software identifier
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe software identifier
....... cd 1..1codethe type of the hcparty
....... name 0..1stringThe name of the application.
.... folder 1..1ClassThe only data that matters
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... idkmehr 1..1integerID-KMEHR
..... patient 1..1Classthe patient
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idinss 0..1stringthe Belgian Social Security Number identifier
...... firstname 0..1stringFirst name of the patient. If no first name exists, the element will be empty.
...... familyname 0..1stringFamily name of the patient
...... birthdate 0..1dateBirth date of the patient (uses the basic data types for dates)
...... deathdate 0..1datethis is not used
...... sex 1..1ClassSex of the patient
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... cd 1..1codeCoded value of patient sex
...... address 0..1ClassHome, work, … address(es) of the patient.
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... cd 1..1codeCoded value
....... zip 0..1integerZip-code of the city
....... city 0..1stringThe name of the city
....... street 0..1stringThe name of the street
....... housenumber 0..1stringHousenumber within the street
...... nationality 0..1stringNationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
....... @id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
....... @value 0..1stringPrimitive value for string
Max Length: 1048576
....... cd 1..1codeCoded value
...... usuallanguage 0..1stringUsual language of the patient using the W3C language codes.
...... telecom 0..1stringFax, phone, … number(s) of the patient.
...... recorddatetime 0..1ANYDate of recording of the patient data.
...... text 0..1stringComment about the patient.
..... MSTransaction 1..1ClassThe metadata for the message
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idothers 0..*integerLocal ID of the medication line
...... cd 1..1codecode
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1Classthe identifier of the hub
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... version 0..1integerversion of the medication scheme
..... MSETransactionTreatmentSuspension 0..*ClassThe treatment suspension line(s)
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idkmehr 1..1integerthe KMEHR identifier for the medication line
...... idother 0..*stringLocal ID of the medication line
...... cd 0..*codeCoded value
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1Classthe identifier of the hub
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... itemmedication 0..*ClassThis describes the medication it is linked to, but has no further relevance
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... beginMoment 1..1ClassThe beginmoment of the medication/treatment suspension
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... endMoment 0..1Classthe end date (and time) of the suspension
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... content 0..*ClassTo Do
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..*ClassDescription of the medicinal product
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
......... intendedCd 0..1CDCD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..*ClassDescription of the generic product
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1CDCode of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCode of delivered product (CNK)
........ compoundprescription 0..*ClassDescription of the compound product
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... magistraltext 1..1STRecipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... text 0..*stringMandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
....... lifecycle 1..1stringThe indication of the status, only used in a TS with value 'suspended'
....... lnk 1..1stringusing a link to the transaction (in the current MedicationSchema) of the related medicine
...... itemtransactionreason 0..1ClassExtra information on the reason of suspention of the linked medication
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contenttext 0..*ClassText
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: Temporairement ne pas prendre en raison de l'interaction avec Y.
..... MSETransactionmedication 0..*ClassThe medication lines
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idkmehr 1..1integerthe KMEHR identifier for the medication line
...... idother 0..*stringLocal ID of the medication line
...... cd 0..*codeCoded value
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1Classthe identifier of the hub
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... version 0..*stringTO DO
...... itemmedicationUse 0..1ClassExtra information on the usage of the medication within this transaction
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itemendCondition 0..1ClassExtra information on the endcondition of the medication within this MSE-transaction
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itembeginCondition 0..1ClassExtra information on the begincondition of the medication within this MSE-transaction
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itemmedication 0..*ClassTo Do
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... beginMoment 1..1ClassThe beginmoment of the medication/treatment suspension
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... endMoment 0..1ClassThe end moment of the medication/treatment suspension
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... duration 0..1integerThe duration of the treatment
....... contentmedicationIdentification 0..*ClassTo Do
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..*ClassDescription of the medicinal product
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
......... intendedCd 0..1CDCD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..*ClassDescription of the generic product
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1CDCode of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCode of delivered product (CNK)
........ compoundprescription 0..*ClassDescription of the compound product
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... magistraltext 1..1STRecipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... content 0..*stringExtra content field which can be added if neccessary
....... text 0..*stringMandatory if compoundprescription is used

Example Example: Aluminiumchloride transpiratieremmende hydroalcoholische oplossing 15 % TMF
....... temporality 0..*ClassThe temporality
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..1stringCoded value
....... frequency 0..*ClassTo Do
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ periodicity 0..*ClassTo Do
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 0..*ANYS-VALUE=CD-PERIODICITY
....... posology 0..*ClassThe freetext posology is mutual exclusive with the structured Regimen
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..1stringContains the ingestion pattern in textual form
Example Example: tot 4 x per dag 1 tablet
....... regimen 0..*ClassTo Do
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 0..*datedate, mostly used icw periodicity=monthly or at a specifiec time of the day
........ weekday 0..*integerDay of the week, mostly used icw periodicity=weekly
......... @id 0..1stringxml:id (or equivalent in JSON)
......... extension 0..*ExtensionAdditional content defined by implementations
......... @value 0..1integerPrimitive value for integer
......... cd 1..1stringthe day of the week
Example Example: monday
........ daynumber 0..*integerDaynumber, mostly used icw periodicity=weekly or daily
........ daytime 0..*Classindication of the intake moment
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... time 1..1dateThe time when the line was registered in the schema
......... dayperiod 1..*Classmutual exclusive with <time>
.......... @id 0..1stringUnique id for inter-element referencing
.......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.......... cd 0..*stringCoded value
........ quantity 1..1ClassTo Do
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... decimal 0..*integerthe amount, expressed in a number
......... unit 0..*Classthe prescribed administration unit where the decimal applies to
.......... @id 0..1stringUnique id for inter-element referencing
.......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.......... cd 0..*stringTo Do
....... route 0..*ClassThe drug administration route
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ANYTo Do
....... instructionforpatient 0..1stringUsage instructions for the patient.
Example Example: A diminuer si possible

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Differential View

This structure is derived from Base

NameFlagsCard.TypeDescription & Constraintsdoco
.. KMEHRMS 0..*BaseKMEHR Medication Schema v5.8
Instances of this logical model are not marked to be the target of a Reference
... KMEHRMessage 1..1ClassKMEHR Message
.... header 1..1ClassKMEHR Message header
..... standard 1..1ClassWhich version of the standard is used
...... cd 1..1CDThe version of the KMEHR standard used
..... date 0..1dateDate
..... time 0..1timeTime
..... sender 0..1ClassSender
...... hcpartyHub 0..1Classthe identifier of the hub
....... itemId 1..1stringthe hub identifier
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... name 0..1stringthe name of the hub
...... hcpartyOrg 0..1Classthe identifier of the org
....... itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... idencryptionApplication 0..1ANYApplication
....... cdencryptionActor 0..1ClassUsage & cardinality
....... name 0..1stringThe name of the org
...... hcpartyindividual 1..1Classthe identifier of the individual
....... idriziv 0..1stringthe RIZIV individual identifier
....... idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... cd 1..1codethe type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1Classto be checked: usage & cardinality
....... firstname 0..1stringthe first name of the individual
....... familyname 0..1stringthe last name of the individual
Example Example: Hendrix
....... address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
........ cd 1..1ClassCoded value
........ nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..*stringFax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1Classthe software identifier
....... itemId 0..1stringthe software identifier
....... cd 1..1codethe type of the hcparty
....... name 0..1stringThe name of the application.
..... recipient 0..1ClassRecipient
...... hcpartyHub 0..1Classthe identifier of the hub
....... itemId 1..1stringthe hub identifier
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... name 0..1stringthe name of the hub
...... hcpartyOrg 0..1Classthe identifier of the org
....... itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... idencryptionApplication 0..1ANYApplication
....... cdencryptionActor 0..1ClassUsage & cardinality
....... name 0..1stringThe name of the org
...... hcpartyindividual 1..1Classthe identifier of the individual
....... idriziv 0..1stringthe RIZIV individual identifier
....... idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... cd 1..1codethe type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1Classto be checked: usage & cardinality
....... firstname 0..1stringthe first name of the individual
....... familyname 0..1stringthe last name of the individual
Example Example: Hendrix
....... address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
........ cd 1..1ClassCoded value
........ nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..*stringFax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1Classthe software identifier
....... itemId 0..1stringthe software identifier
....... cd 1..1codethe type of the hcparty
....... name 0..1stringThe name of the application.
.... folder 1..1ClassThe only data that matters
..... idkmehr 1..1integerID-KMEHR
..... patient 1..1Classthe patient
...... idinss 0..1stringthe Belgian Social Security Number identifier
...... firstname 0..1stringFirst name of the patient. If no first name exists, the element will be empty.
...... familyname 0..1stringFamily name of the patient
...... birthdate 0..1dateBirth date of the patient (uses the basic data types for dates)
...... deathdate 0..1datethis is not used
...... sex 1..1ClassSex of the patient
....... cd 1..1codeCoded value of patient sex
...... address 0..1ClassHome, work, … address(es) of the patient.
....... cd 1..1codeCoded value
....... zip 0..1integerZip-code of the city
....... city 0..1stringThe name of the city
....... street 0..1stringThe name of the street
....... housenumber 0..1stringHousenumber within the street
...... nationality 0..1stringNationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
....... cd 1..1codeCoded value
...... usuallanguage 0..1stringUsual language of the patient using the W3C language codes.
...... telecom 0..1stringFax, phone, … number(s) of the patient.
...... recorddatetime 0..1ANYDate of recording of the patient data.
...... text 0..1stringComment about the patient.
..... MSTransaction 1..1ClassThe metadata for the message
...... idothers 0..*integerLocal ID of the medication line
...... cd 1..1codecode
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... hcpartyHub 0..1Classthe identifier of the hub
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... version 0..1integerversion of the medication scheme
..... MSETransactionTreatmentSuspension 0..*ClassThe treatment suspension line(s)
...... idkmehr 1..1integerthe KMEHR identifier for the medication line
...... idother 0..*stringLocal ID of the medication line
...... cd 0..*codeCoded value
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... hcpartyHub 0..1Classthe identifier of the hub
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... itemmedication 0..*ClassThis describes the medication it is linked to, but has no further relevance
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... beginMoment 1..1ClassThe beginmoment of the medication/treatment suspension
........ date 1..1dateDate
........ time 0..1timeTime
....... endMoment 0..1Classthe end date (and time) of the suspension
........ date 1..1dateDate
........ time 0..1timeTime
....... content 0..*ClassTo Do
........ medicinalproduct 0..*ClassDescription of the medicinal product
......... intendedName 0..1STName of prescribed product
......... intendedCd 0..1CDCD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..*ClassDescription of the generic product
......... intendedName 0..1STName of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1CDCode of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCode of delivered product (CNK)
........ compoundprescription 0..*ClassDescription of the compound product
......... magistraltext 1..1STRecipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
......... compound 0..0
......... formularyReference 0..0
....... text 0..*stringMandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
....... lifecycle 1..1stringThe indication of the status, only used in a TS with value 'suspended'
....... lnk 1..1stringusing a link to the transaction (in the current MedicationSchema) of the related medicine
...... itemtransactionreason 0..1ClassExtra information on the reason of suspention of the linked medication
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contenttext 0..*ClassText
........ text 1..*stringcardinality to be checked

Example Example: Temporairement ne pas prendre en raison de l'interaction avec Y.
..... MSETransactionmedication 0..*ClassThe medication lines
...... idkmehr 1..1integerthe KMEHR identifier for the medication line
...... idother 0..*stringLocal ID of the medication line
...... cd 0..*codeCoded value
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... hcpartyHub 0..1Classthe identifier of the hub
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... version 0..*stringTO DO
...... itemmedicationUse 0..1ClassExtra information on the usage of the medication within this transaction
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itemendCondition 0..1ClassExtra information on the endcondition of the medication within this MSE-transaction
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itembeginCondition 0..1ClassExtra information on the begincondition of the medication within this MSE-transaction
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itemorigin 0..0
...... itemmedicationType 0..0
...... itemadaptationFlag 0..0
...... itemmedication 0..*ClassTo Do
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... beginMoment 1..1ClassThe beginmoment of the medication/treatment suspension
........ date 1..1dateDate
........ time 0..1timeTime
....... endMoment 0..1ClassThe end moment of the medication/treatment suspension
........ date 1..1dateDate
........ time 0..1timeTime
....... duration 0..1integerThe duration of the treatment
....... contentmedicationIdentification 0..*ClassTo Do
........ medicinalproduct 0..*ClassDescription of the medicinal product
......... intendedName 0..1STName of prescribed product
......... intendedCd 0..1CDCD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..*ClassDescription of the generic product
......... intendedName 0..1STName of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1CDCode of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCode of delivered product (CNK)
........ compoundprescription 0..*ClassDescription of the compound product
......... magistraltext 1..1STRecipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
......... compound 0..0
......... formularyReference 0..0
....... content 0..*stringExtra content field which can be added if neccessary
....... text 0..*stringMandatory if compoundprescription is used

Example Example: Aluminiumchloride transpiratieremmende hydroalcoholische oplossing 15 % TMF
....... temporality 0..*ClassThe temporality
........ cd 0..1stringCoded value
....... frequency 0..*ClassTo Do
........ periodicity 0..*ClassTo Do
......... cd 0..*ANYS-VALUE=CD-PERIODICITY
....... posology 0..*ClassThe freetext posology is mutual exclusive with the structured Regimen
........ text 1..1stringContains the ingestion pattern in textual form
Example Example: tot 4 x per dag 1 tablet
........ low 0..0
........ high 0..0
........ unit 0..0
........ takes 0..0
....... regimen 0..*ClassTo Do
........ date 0..*datedate, mostly used icw periodicity=monthly or at a specifiec time of the day
........ weekday 0..*integerDay of the week, mostly used icw periodicity=weekly
......... cd 1..1stringthe day of the week
Example Example: monday
........ daynumber 0..*integerDaynumber, mostly used icw periodicity=weekly or daily
........ daytime 0..*Classindication of the intake moment
......... time 1..1dateThe time when the line was registered in the schema
......... dayperiod 1..*Classmutual exclusive with <time>
.......... cd 0..*stringCoded value
........ quantity 1..1ClassTo Do
......... decimal 0..*integerthe amount, expressed in a number
......... unit 0..*Classthe prescribed administration unit where the decimal applies to
.......... cd 0..*stringTo Do
....... route 0..*ClassThe drug administration route
........ cd 0..*ANYTo Do
....... instructionForOverDosing 0..0
....... instructionForReimbursement 0..0
....... isSubstitutionAllowed 0..0
....... feedback 0..0
....... local 0..0
....... batch 0..0
....... deliveryDate 0..0
....... instructionforpatient 0..1stringUsage instructions for the patient.
Example Example: A diminuer si possible

doco Documentation for this format

Key Elements View

NameFlagsCard.TypeDescription & Constraintsdoco
.. KMEHRMS 0..*BaseKMEHR Medication Schema v5.8
Instances of this logical model are not marked to be the target of a Reference
... KMEHRMessage 1..1ClassKMEHR Message
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... header 1..1ClassKMEHR Message header
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... standard 1..1ClassWhich version of the standard is used
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... cd 1..1CDThe version of the KMEHR standard used
..... date 0..1dateDate
..... time 0..1timeTime
..... sender 0..1ClassSender
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1Classthe identifier of the hub
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 1..1stringthe hub identifier
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... name 0..1stringthe name of the hub
...... hcpartyOrg 0..1Classthe identifier of the org
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... idencryptionApplication 0..1ANYApplication
....... cdencryptionActor 0..1ClassUsage & cardinality
....... name 0..1stringThe name of the org
...... hcpartyindividual 1..1Classthe identifier of the individual
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... idriziv 0..1stringthe RIZIV individual identifier
....... idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... cd 1..1codethe type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1Classto be checked: usage & cardinality
....... firstname 0..1stringthe first name of the individual
....... familyname 0..1stringthe last name of the individual
Example Example: Hendrix
....... address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 1..1ClassCoded value
........ nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..*stringFax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1Classthe software identifier
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe software identifier
....... cd 1..1codethe type of the hcparty
....... name 0..1stringThe name of the application.
..... recipient 0..1ClassRecipient
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1Classthe identifier of the hub
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 1..1stringthe hub identifier
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... name 0..1stringthe name of the hub
...... hcpartyOrg 0..1Classthe identifier of the org
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... idencryptionApplication 0..1ANYApplication
....... cdencryptionActor 0..1ClassUsage & cardinality
....... name 0..1stringThe name of the org
...... hcpartyindividual 1..1Classthe identifier of the individual
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... idriziv 0..1stringthe RIZIV individual identifier
....... idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... cd 1..1codethe type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1Classto be checked: usage & cardinality
....... firstname 0..1stringthe first name of the individual
....... familyname 0..1stringthe last name of the individual
Example Example: Hendrix
....... address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 1..1ClassCoded value
........ nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..*stringFax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1Classthe software identifier
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe software identifier
....... cd 1..1codethe type of the hcparty
....... name 0..1stringThe name of the application.
.... folder 1..1ClassThe only data that matters
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... idkmehr 1..1integerID-KMEHR
..... patient 1..1Classthe patient
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idinss 0..1stringthe Belgian Social Security Number identifier
...... firstname 0..1stringFirst name of the patient. If no first name exists, the element will be empty.
...... familyname 0..1stringFamily name of the patient
...... birthdate 0..1dateBirth date of the patient (uses the basic data types for dates)
...... deathdate 0..1datethis is not used
...... sex 1..1ClassSex of the patient
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... cd 1..1codeCoded value of patient sex
...... address 0..1ClassHome, work, … address(es) of the patient.
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... cd 1..1codeCoded value
....... zip 0..1integerZip-code of the city
....... city 0..1stringThe name of the city
....... street 0..1stringThe name of the street
....... housenumber 0..1stringHousenumber within the street
...... nationality 0..1stringNationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
....... cd 1..1codeCoded value
...... usuallanguage 0..1stringUsual language of the patient using the W3C language codes.
...... telecom 0..1stringFax, phone, … number(s) of the patient.
...... recorddatetime 0..1ANYDate of recording of the patient data.
...... text 0..1stringComment about the patient.
..... MSTransaction 1..1ClassThe metadata for the message
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idothers 0..*integerLocal ID of the medication line
...... cd 1..1codecode
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1Classthe identifier of the hub
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... version 0..1integerversion of the medication scheme
..... MSETransactionTreatmentSuspension 0..*ClassThe treatment suspension line(s)
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idkmehr 1..1integerthe KMEHR identifier for the medication line
...... idother 0..*stringLocal ID of the medication line
...... cd 0..*codeCoded value
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1Classthe identifier of the hub
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... itemmedication 0..*ClassThis describes the medication it is linked to, but has no further relevance
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... beginMoment 1..1ClassThe beginmoment of the medication/treatment suspension
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... endMoment 0..1Classthe end date (and time) of the suspension
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... content 0..*ClassTo Do
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..*ClassDescription of the medicinal product
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
......... intendedCd 0..1CDCD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..*ClassDescription of the generic product
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1CDCode of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCode of delivered product (CNK)
........ compoundprescription 0..*ClassDescription of the compound product
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... magistraltext 1..1STRecipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... text 0..*stringMandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
....... lifecycle 1..1stringThe indication of the status, only used in a TS with value 'suspended'
....... lnk 1..1stringusing a link to the transaction (in the current MedicationSchema) of the related medicine
...... itemtransactionreason 0..1ClassExtra information on the reason of suspention of the linked medication
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contenttext 0..*ClassText
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: Temporairement ne pas prendre en raison de l'interaction avec Y.
..... MSETransactionmedication 0..*ClassThe medication lines
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idkmehr 1..1integerthe KMEHR identifier for the medication line
...... idother 0..*stringLocal ID of the medication line
...... cd 0..*codeCoded value
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1Classthe identifier of the hub
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... version 0..*stringTO DO
...... itemmedicationUse 0..1ClassExtra information on the usage of the medication within this transaction
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itemendCondition 0..1ClassExtra information on the endcondition of the medication within this MSE-transaction
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itembeginCondition 0..1ClassExtra information on the begincondition of the medication within this MSE-transaction
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itemmedication 0..*ClassTo Do
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... beginMoment 1..1ClassThe beginmoment of the medication/treatment suspension
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... endMoment 0..1ClassThe end moment of the medication/treatment suspension
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... duration 0..1integerThe duration of the treatment
....... contentmedicationIdentification 0..*ClassTo Do
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..*ClassDescription of the medicinal product
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
......... intendedCd 0..1CDCD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..*ClassDescription of the generic product
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1CDCode of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCode of delivered product (CNK)
........ compoundprescription 0..*ClassDescription of the compound product
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... magistraltext 1..1STRecipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... content 0..*stringExtra content field which can be added if neccessary
....... text 0..*stringMandatory if compoundprescription is used

Example Example: Aluminiumchloride transpiratieremmende hydroalcoholische oplossing 15 % TMF
....... temporality 0..*ClassThe temporality
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..1stringCoded value
....... frequency 0..*ClassTo Do
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ periodicity 0..*ClassTo Do
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 0..*ANYS-VALUE=CD-PERIODICITY
....... posology 0..*ClassThe freetext posology is mutual exclusive with the structured Regimen
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..1stringContains the ingestion pattern in textual form
Example Example: tot 4 x per dag 1 tablet
....... regimen 0..*ClassTo Do
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 0..*datedate, mostly used icw periodicity=monthly or at a specifiec time of the day
........ weekday 0..*integerDay of the week, mostly used icw periodicity=weekly
......... cd 1..1stringthe day of the week
Example Example: monday
........ daynumber 0..*integerDaynumber, mostly used icw periodicity=weekly or daily
........ daytime 0..*Classindication of the intake moment
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... time 1..1dateThe time when the line was registered in the schema
......... dayperiod 1..*Classmutual exclusive with <time>
.......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.......... cd 0..*stringCoded value
........ quantity 1..1ClassTo Do
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... decimal 0..*integerthe amount, expressed in a number
......... unit 0..*Classthe prescribed administration unit where the decimal applies to
.......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.......... cd 0..*stringTo Do
....... route 0..*ClassThe drug administration route
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ANYTo Do
....... instructionforpatient 0..1stringUsage instructions for the patient.
Example Example: A diminuer si possible

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

Snapshot View

NameFlagsCard.TypeDescription & Constraintsdoco
.. KMEHRMS 0..*BaseKMEHR Medication Schema v5.8
Instances of this logical model are not marked to be the target of a Reference
... KMEHRMessage 1..1ClassKMEHR Message
.... @id 0..1stringUnique id for inter-element referencing
.... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.... header 1..1ClassKMEHR Message header
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... standard 1..1ClassWhich version of the standard is used
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... cd 1..1CDThe version of the KMEHR standard used
..... date 0..1dateDate
..... time 0..1timeTime
..... sender 0..1ClassSender
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1Classthe identifier of the hub
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 1..1stringthe hub identifier
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... name 0..1stringthe name of the hub
...... hcpartyOrg 0..1Classthe identifier of the org
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... idencryptionApplication 0..1ANYApplication
....... cdencryptionActor 0..1ClassUsage & cardinality
....... name 0..1stringThe name of the org
...... hcpartyindividual 1..1Classthe identifier of the individual
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... idriziv 0..1stringthe RIZIV individual identifier
....... idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... cd 1..1codethe type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1Classto be checked: usage & cardinality
....... firstname 0..1stringthe first name of the individual
....... familyname 0..1stringthe last name of the individual
Example Example: Hendrix
....... address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 1..1ClassCoded value
........ nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..*stringFax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1Classthe software identifier
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe software identifier
....... cd 1..1codethe type of the hcparty
....... name 0..1stringThe name of the application.
..... recipient 0..1ClassRecipient
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... hcpartyHub 0..1Classthe identifier of the hub
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 1..1stringthe hub identifier
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... name 0..1stringthe name of the hub
...... hcpartyOrg 0..1Classthe identifier of the org
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
....... cd 1..1codethe type of the hcparty
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... idencryptionApplication 0..1ANYApplication
....... cdencryptionActor 0..1ClassUsage & cardinality
....... name 0..1stringThe name of the org
...... hcpartyindividual 1..1Classthe identifier of the individual
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... idriziv 0..1stringthe RIZIV individual identifier
....... idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
....... idencryptionActor 0..1integerto be checked: usage & cardinality
....... cd 1..1codethe type of the hcparty
Example Example: persphysician
....... cdencryptionActor 0..1Classto be checked: usage & cardinality
....... firstname 0..1stringthe first name of the individual
....... familyname 0..1stringthe last name of the individual
Example Example: Hendrix
....... address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 1..1ClassCoded value
........ nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
....... telecom 0..*stringFax, phone, … number(s) of the healthcare party.
...... hcpartyapplication 0..1Classthe software identifier
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..1stringthe software identifier
....... cd 1..1codethe type of the hcparty
....... name 0..1stringThe name of the application.
.... folder 1..1ClassThe only data that matters
..... @id 0..1stringUnique id for inter-element referencing
..... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
..... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
..... idkmehr 1..1integerID-KMEHR
..... patient 1..1Classthe patient
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idinss 0..1stringthe Belgian Social Security Number identifier
...... firstname 0..1stringFirst name of the patient. If no first name exists, the element will be empty.
...... familyname 0..1stringFamily name of the patient
...... birthdate 0..1dateBirth date of the patient (uses the basic data types for dates)
...... deathdate 0..1datethis is not used
...... sex 1..1ClassSex of the patient
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... cd 1..1codeCoded value of patient sex
...... address 0..1ClassHome, work, … address(es) of the patient.
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... cd 1..1codeCoded value
....... zip 0..1integerZip-code of the city
....... city 0..1stringThe name of the city
....... street 0..1stringThe name of the street
....... housenumber 0..1stringHousenumber within the street
...... nationality 0..1stringNationality of the patient. Initially, the use of the CD-COUNTRY dictionary was required. We now recommend the use of the CD-FED-COUNTRY dictionary.
....... @id 0..1stringxml:id (or equivalent in JSON)
....... extension 0..*ExtensionAdditional content defined by implementations
....... @value 0..1stringPrimitive value for string
Max Length: 1048576
....... cd 1..1codeCoded value
...... usuallanguage 0..1stringUsual language of the patient using the W3C language codes.
...... telecom 0..1stringFax, phone, … number(s) of the patient.
...... recorddatetime 0..1ANYDate of recording of the patient data.
...... text 0..1stringComment about the patient.
..... MSTransaction 1..1ClassThe metadata for the message
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idothers 0..*integerLocal ID of the medication line
...... cd 1..1codecode
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1Classthe identifier of the hub
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... version 0..1integerversion of the medication scheme
..... MSETransactionTreatmentSuspension 0..*ClassThe treatment suspension line(s)
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idkmehr 1..1integerthe KMEHR identifier for the medication line
...... idother 0..*stringLocal ID of the medication line
...... cd 0..*codeCoded value
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1Classthe identifier of the hub
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... itemmedication 0..*ClassThis describes the medication it is linked to, but has no further relevance
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... beginMoment 1..1ClassThe beginmoment of the medication/treatment suspension
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... endMoment 0..1Classthe end date (and time) of the suspension
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... content 0..*ClassTo Do
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..*ClassDescription of the medicinal product
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
......... intendedCd 0..1CDCD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..*ClassDescription of the generic product
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1CDCode of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCode of delivered product (CNK)
........ compoundprescription 0..*ClassDescription of the compound product
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... magistraltext 1..1STRecipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... text 0..*stringMandatory if compoundprescription is used - !!to be checked if possible in TS transaction!!
....... lifecycle 1..1stringThe indication of the status, only used in a TS with value 'suspended'
....... lnk 1..1stringusing a link to the transaction (in the current MedicationSchema) of the related medicine
...... itemtransactionreason 0..1ClassExtra information on the reason of suspention of the linked medication
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contenttext 0..*ClassText
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: Temporairement ne pas prendre en raison de l'interaction avec Y.
..... MSETransactionmedication 0..*ClassThe medication lines
...... @id 0..1stringUnique id for inter-element referencing
...... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
...... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
...... idkmehr 1..1integerthe KMEHR identifier for the medication line
...... idother 0..*stringLocal ID of the medication line
...... cd 0..*codeCoded value
...... date 1..1dateThe date when the line was registered in the schema
...... time 1..1dateThe time when the line was registered in the schema
...... author 1..1ClassThe author of the line in the schema
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... hcpartyHub 0..1Classthe identifier of the hub
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 1..1stringthe hub identifier
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ name 0..1stringthe name of the hub
....... hcpartyOrg 0..1Classthe identifier of the org
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe org identifier - NIHDII number of the org
Example Example: 1990001916
........ cd 1..1codethe type of the hcparty
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ idencryptionApplication 0..1ANYApplication
........ cdencryptionActor 0..1ClassUsage & cardinality
........ name 0..1stringThe name of the org
....... hcpartyindividual 1..1Classthe identifier of the individual
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ idriziv 0..1stringthe RIZIV individual identifier
........ idinss 0..1stringthe Belgian Social Security Number identifier
Example Example: 69060733632
........ idencryptionActor 0..1integerto be checked: usage & cardinality
........ cd 1..1codethe type of the hcparty
Example Example: persphysician
........ cdencryptionActor 0..1Classto be checked: usage & cardinality
........ firstname 0..1stringthe first name of the individual
........ familyname 0..1stringthe last name of the individual
Example Example: Hendrix
........ address 0..*ClassHome, work, ... address(es) of the patient or healthcare party.
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 1..1ClassCoded value
......... nis 0..1codeexplanation: https://nl.wikipedia.org/wiki/NIS-code
Example Example: 24062
........ telecom 0..*stringFax, phone, … number(s) of the healthcare party.
....... hcpartyapplication 0..1Classthe software identifier
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ itemId 0..1stringthe software identifier
........ cd 1..1codethe type of the hcparty
........ name 0..1stringThe name of the application.
...... isComplete 1..1booleanis complete
...... isValidated 1..1booleanis validated
...... version 0..*stringTO DO
...... itemmedicationUse 0..1ClassExtra information on the usage of the medication within this transaction
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itemendCondition 0..1ClassExtra information on the endcondition of the medication within this MSE-transaction
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itembeginCondition 0..1ClassExtra information on the begincondition of the medication within this MSE-transaction
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... contentcategory 1..*ClassCategory
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ClassCoded value
....... contenttext 0..*ClassText
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..*stringcardinality to be checked

Example Example: pression artérielle
...... itemmedication 0..*ClassTo Do
....... @id 0..1stringUnique id for inter-element referencing
....... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
....... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
....... itemId 0..*integera sequential unique item ID within the transaction, start=1
....... cd 0..*ANYdescribes the item category
....... beginMoment 1..1ClassThe beginmoment of the medication/treatment suspension
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... endMoment 0..1ClassThe end moment of the medication/treatment suspension
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 1..1dateDate
........ time 0..1timeTime
....... duration 0..1integerThe duration of the treatment
....... contentmedicationIdentification 0..*ClassTo Do
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ medicinalproduct 0..*ClassDescription of the medicinal product
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
......... intendedCd 0..1CDCD-DRUG-CNK + Code (CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCD-DRUG-CNK + Code (CNK)
........ substanceproduct 0..*ClassDescription of the generic product
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... intendedName 0..1STName of prescribed product
Example Example: chloorfenamine + paracetamol oraal 3,2 mg + 240 mg
......... intendedCd 0..1CDCode of prescribed product (VMPGROUP or CNK)
......... deliveredName 0..1STName of delivered product
......... deliveredCd 0..1CDCode of delivered product (CNK)
........ compoundprescription 0..*ClassDescription of the compound product
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... magistraltext 1..1STRecipe of the prescription
Example Example: R/ Aluminiumchloride hexahydraat 15 g + Isopropylalcohol 78 g + Gezuiverd water q.s. ad 100 g T
....... content 0..*stringExtra content field which can be added if neccessary
....... text 0..*stringMandatory if compoundprescription is used

Example Example: Aluminiumchloride transpiratieremmende hydroalcoholische oplossing 15 % TMF
....... temporality 0..*ClassThe temporality
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..1stringCoded value
....... frequency 0..*ClassTo Do
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ periodicity 0..*ClassTo Do
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... cd 0..*ANYS-VALUE=CD-PERIODICITY
....... posology 0..*ClassThe freetext posology is mutual exclusive with the structured Regimen
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ text 1..1stringContains the ingestion pattern in textual form
Example Example: tot 4 x per dag 1 tablet
....... regimen 0..*ClassTo Do
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ date 0..*datedate, mostly used icw periodicity=monthly or at a specifiec time of the day
........ weekday 0..*integerDay of the week, mostly used icw periodicity=weekly
......... @id 0..1stringxml:id (or equivalent in JSON)
......... extension 0..*ExtensionAdditional content defined by implementations
......... @value 0..1integerPrimitive value for integer
......... cd 1..1stringthe day of the week
Example Example: monday
........ daynumber 0..*integerDaynumber, mostly used icw periodicity=weekly or daily
........ daytime 0..*Classindication of the intake moment
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... time 1..1dateThe time when the line was registered in the schema
......... dayperiod 1..*Classmutual exclusive with <time>
.......... @id 0..1stringUnique id for inter-element referencing
.......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.......... cd 0..*stringCoded value
........ quantity 1..1ClassTo Do
......... @id 0..1stringUnique id for inter-element referencing
......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
......... decimal 0..*integerthe amount, expressed in a number
......... unit 0..*Classthe prescribed administration unit where the decimal applies to
.......... @id 0..1stringUnique id for inter-element referencing
.......... extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
.......... modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
.......... cd 0..*stringTo Do
....... route 0..*ClassThe drug administration route
........ @id 0..1stringUnique id for inter-element referencing
........ extension 0..*ExtensionAdditional content defined by implementations
Slice: Unordered, Open by value:url
........ modifierExtension ?!Σ0..*ExtensionExtensions that cannot be ignored even if unrecognized
........ cd 0..*ANYTo Do
....... instructionforpatient 0..1stringUsage instructions for the patient.
Example Example: A diminuer si possible

doco Documentation for this format

Constraints

IdGradePath(s)DetailsRequirements
ele-1error**ALL** elementsAll FHIR elements must have a @value or children
: hasValue() or (children().count() > id.count())
ext-1error**ALL** extensionsMust have either extensions or value[x], not both
: extension.exists() != value.exists()

 

Other representations of profile: CSV, Excel